docs: clarify reviewer-enforced SRP/DRY expectations in AGENTS#22
docs: clarify reviewer-enforced SRP/DRY expectations in AGENTS#22sidneyswift wants to merge 1 commit intomainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded a new "Reviewer Expectations (PR-blocking)" section to AGENTS.md documenting SRP/DRY enforcement rules for PR reviews, including guidelines for barrel files, per-file responsibilities, shared schemas, and utility reuse. The content appears in two locations within the document. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
recoup-coding-agent
left a comment
recoup-coding-agent
left a comment
There was a problem hiding this comment.
Code Review: Clarify reviewer-enforced SRP/DRY expectations in AGENTS.md
Summary
Docs-only change. Adds a "Reviewer Expectations (PR-blocking)" section and a pre-PR checklist to AGENTS.md to make clear that SRP/DRY violations are blocking feedback, not style preferences.
Assessment
✅ Adds explicit, actionable guidance that was previously implicit.
✅ Checklist format makes expectations easy to follow before pushing.
✅ No code changes — zero production risk.
🔵 Nit
"Barrel-only index files" item mentions index.ts specifically — worth noting index.js / index.tsx if the repo uses those too, but this is very minor.
Verdict: approve
Clear, useful documentation improvement.
2 participants
What this updates\n- Adds explicit reviewer-enforced SRP/DRY rules to root \n- Defines PR-blocking expectations (barrel files, shared contracts, schema reuse)\n- Adds a pre-PR SRP/DRY checklist for coding agents\n\n## Why\nRecent review feedback showed that high-level SRP/DRY guidance was too ambiguous. This change makes reviewer expectations concrete so future agent-authored PRs align on first pass.\n\n## Scope\n- Docs-only change\n- No runtime code changes
Summary by CodeRabbit